コマンドラインモードでのエージェントの実行(DAIランエージェント)
DAI ランエージェントは、ユーザーインターフェイスなしでコマンドラインから設定および実行することができます。
-
コマンドプロンプトからエージェントディレクトリに移動します。例えば:
- Windows の場合:
C:\Program Files (x86)\eggplantDAIRunAgent\ - Mac の場合:
/Applications - Linux の場合:(
eggplantDAIRunAgent実行ファイルが抽出されたパス)
- Windows の場合:
-
エージェント実行ファイルを実行し、適切な引数を追加します:
- Windows の場合:
eggplantDAIRunAgent.exe [引数] - Mac の場合:
./eggplantDAIRunAgent [引数] - Linux の場合:
./eggplantDAIRunAgent [引数]
- Windows の場合:
コマンドウィンドウを介してコマンドライン引数でエージェントを起動する際には注意してください。引数の入力を間違えると、コマンドウィンドウが即座に閉じてしまい、ログは作成されません。
DAI ランエージェントの実行例
DAI ランエージェントにダウンロードした.iniファイルのパスを提供し、そのファイルに設定が 1 セクションだけ含まれている場合、追加の引数を提供する必要はありません。Mac または Linux ベースのシステムの bash シェル端末で、EPF の GUI が必要ない場合は、次の引数でランエージェントを起動できます:
./eggplantDAIRunAgent --ini-file "my envs/my_env.ini"
ファイルパスにスペースが含まれている場合は、引用符で囲む必要があります。
以下は、より詳細ですがオプションの引数を使用して、異なるオペレーティングシステムで DAI ランエージェントを実行する例です。.iniファイルに複数のセクションが含まれている場合、DAI デザインエージェントが使用するものとして、--host-urlと--env-idのみを提供する必要があります。
Windows
cd C:\Program Files (x86)\eggplantDAIRunAgent
eggplantDAIRunAgent.exe --ini-file envs\my_env.ini --host-url https://server.company.com --env-id 1 --gui True --log-level DEBUG
Mac/Linux
./eggplantDAIRunAgent --ini-file envs/my_env.ini --host-url https://server.company.com --env-id 1 --gui True --log-level DEBUG
コマンドライン引数
コマンドライン引数の完全なリスト、使用方法、および機能については、--helpフラグを使用してランナーを起動することで確認できます。
Windows の場合:
cd C:\Program Files (x86)\eggplantDAIRunAgent
eggplantDAIRunAgent.exe --help
Mac/Linux の場合:
./eggplantDAIRunAgent --help
以下は、サポートされているコマンドライン引数と対応する環境変数のリストです。
| 引数 | 環境変数 | 説明 |
|---|---|---|
--ini-file FILE | DAI_AGENT_INI_FILE | DAI サーバーからダウンロードされた環境設定(.ini)ファイルの場所。(.ini)ファイルは、ダウンロードされた ini ファイルをロードする際にのみ作成されます。デフォルト: Windows: C:\Users\{user}\.eggplantDAI.ini(非表示にマークされています。)Mac: ~/.eggplantDAI.iniLinux: ~/.eggplantDAI.ini |
--host-url TEXT | DAI_HOST_URL | 接続する Eggplant DAI サーバー、例:https://server.company.com。これは、環境設定(.ini)ファイルのhost_urlにマップされます。--env-idと組み合わせて.iniファイルの適切なセクションを選択するため に使用します。指定されていない場合は、.ini ファイルの最初のセクションを使用します。 |
--env-id INTEGER | DAI_EXEC_ENV_ID | DAI サーバー上の実行環境の ID。--host-urlと組み合わせて.iniファイルの適切なセクションを選択するために使用します。指定されていない場合は、.ini ファイルの最初のセクションを使用します。 |
--suite-root DIRECTORY | EGGDRIVE_SUITE_ROOT | ダウンロードされたスイートを保存するためのフォルダ。 Eggplant Functional スイートは、指定されたルートフォルダのサブルダとしてアップロードおよびダウンロードされます。 デフォルト: Windows: C:\ProgramData\Eggplant\agent\SuitesMac: ~/Library/Application Support/agent/suitesLinux: ~/.local/share/agent/suites |
--gui [True|False] | Eggplant Functional の UI を表示するかどうかを指定します。 デフォルト: False | |
--drive-port INTEGER | EGGDRIVE_PORT | Eggplant Functional が eggDrive コマンドをリッスンするために使用するポート。 指定されていない場合は、ランダムに割り当てられた空きポートを使用します。 |
--epf FILE | EGGDRIVE_EXEC | Eggplant Functional runscript ファイルの場所。runscript ファイルはコマンドラインから Eggplant Functional を実行するために使用されます。 デフォルト: Windows: C:\Program Files\Eggplant\Eggplant.app\runscript.exeMac: /Applications/Eggplant.app/Contents/MacOS/runscriptLinux: /usr/local/bin/runscript |
--log-level [INFO|DEBUG|TRACE] | ログレベル。INFO: 物事が期待通りに動作していることを確認する基本的なメッセージ。DEBUG: 問題の診断時に詳細なメッセージを提供します。TRACE: すべてのレベルのログを表示します。デフォルト: DEBUG | |
--log-folder DIRECTORY | DAI_AGENT_LOG_FOLDER | ログファイルを保存するためのフォルダ。 デフォルト: Windows: C:\ProgramData\Eggplant\agent\logsMac: ~/Library/Logs/agentLinux: ~/.cache/agent/log |
--licenser-host TEXT | [オプション] Licenser ホストを指定するための追加の EPF 引数。 | |
--version | バージョンを表示します。 | |
--help | ヘルプメッセージを表示し、終了します。 |
テスト設定実行のための Eggplant Functional 停止および再起動設定
テスト設定を実行する際に、Eggplant Functional(EPF)を再起動するまでの実行時間や、ポーリング停止および再起動のための猶予期間を次の環境変数で設定できます。 詳細はテスト設定実行のための Eggplant Functional 停止および再起動設定を参照してください。
| 環境変数 | デフォルト | 説明 |
|---|---|---|
RESTART_EPF_AFTER_SECONDS | 1800 | EPF が起動してから次の EPF 再起動までの期間。この変数は現在のステップが終了し、次のステップに移る前に有効になります。これは DAI ランエージェントでのテスト設定実行にのみ適用されます。ライブランでは、EPF は再起動せずに連続して実行されます。デフォルトは 30 分です。 |
EPF_QUIT_POLL_TIME_SECONDS | 20 | 再起動プロセス中に EPF が終了するための猶予期間。 |
EPF_RESTART_POLL_TIME_SECONDS | 120 | EPF が終了した後に起動するための猶予期間。EPF_RESTART_POLL_TIME_SECONDSにはEPF_QUIT_POLL_TIME_SECONDSは含まれません。 |